<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.results</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;results
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module results</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.core.results-pysrc.html">source&nbsp;code</a></span></p>
<p>Containers for various simulation results. Each result type is a child
  class of the Result class, which provides common capabilities for all 
  result types. The simulator sends all results, regardless of type, to an 
  output handler, which may in turn send the results through a pipeline for
  post-processing and disk storage.</p>
  <p>This module also provides Result-producing replacement functions for 
  the kernel trace and metadata routines.</p>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.Result-class.html" class="summary-name">Result</a><br />
      Base class for simulation results.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.AggregationResult-class.html" class="summary-name">AggregationResult</a><br />
      Result type produced by the Aggregator component.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.DiscardResult-class.html" class="summary-name">DiscardResult</a><br />
      Result created whenever a job is discarded without simulating its 
        execution.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.DiscrepancyResult-class.html" class="summary-name">DiscrepancyResult</a><br />
      Result type produced whenever a job, or the simulated grid, must be
        changed due to invalid information contained in the job trace.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.FileRequestResult-class.html" class="summary-name">FileRequestResult</a><br />
      Result that occurs whenever a file is requested from a FileCache
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.FileTransferResult-class.html" class="summary-name">FileTransferResult</a><br />
      Result to record a transfer from a FileStore to a FileCache (in the
        event of a cache miss) or another other file transfer
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.JobResult-class.html" class="summary-name">JobResult</a><br />
      Record of a Job, entered into the output pipeline whenever the job 
        completes or is discarded
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.JobStartResult-class.html" class="summary-name">JobStartResult</a><br />
      Record dispatched when a job is started
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.JobSubmitResult-class.html" class="summary-name">JobSubmitResult</a><br />
      Result that is sent when a job is successfully submitted
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.MetadataResult-class.html" class="summary-name">MetadataResult</a><br />
      Result class for injecting metadata into the simulator output.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.SchedResult-class.html" class="summary-name">SchedResult</a><br />
      Scheduling result record, which encodes the scheduler status 
        information both for the entire scheduler and for each Virtual 
        Organization seen by the scheduler.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.SiteRejectionResult-class.html" class="summary-name">SiteRejectionResult</a><br />
      Result that records the rejection of a site at creation time, 
        specifying the site name and reason for rejection.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.SiteResult-class.html" class="summary-name">SiteResult</a><br />
      Result that records the presence or absence of a site on the grid.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.TraceResult-class.html" class="summary-name">TraceResult</a><br />
      Result produced by the kernel_trace function in this module, to 
        record the simulation trace as part of the output data
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.VMPilotResult-class.html" class="summary-name">VMPilotResult</a><br />
      Result produced by Virtual Machine pilot jobs whenever the pilot 
        state changes
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.VMResult-class.html" class="summary-name">VMResult</a><br />
      Result produced whenever a Virtual Machine changes state
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.VOResult-class.html" class="summary-name">VOResult</a><br />
      Result that records the observation of a single Virtual 
        Organization in the trace data.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.VOCResult-class.html" class="summary-name">VOCResult</a><br />
      Result used for periodic updates on the state of a Virtual 
        Organization Cluster.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results.WatchdogResult-class.html" class="summary-name">WatchdogResult</a><br />
      Result periodically produced to monitor the state of the watchdog 
        component
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="simvoc.core.results.TraceResult-class.html" 
      class="link">results.TraceResult</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results-module.html#kernel_trace" class="summary-sig-name">kernel_trace</a>(<span class="summary-sig-arg">simtime</span>,
        <span class="summary-sig-arg">realtime</span>,
        <span class="summary-sig-arg">msg</span>,
        <span class="summary-sig-arg">qsize</span>,
        <span class="summary-sig-arg">events</span>,
        <span class="summary-sig-arg">rate</span>,
        <span class="summary-sig-arg">de</span>,
        <span class="summary-sig-arg">dq</span>)</span><br />
      Result-producing replacement for the kernel trace function</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#kernel_trace">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="simvoc.core.results.MetadataResult-class.html" 
      class="link">results.MetadataResult</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results-module.html#kernel_metadata" class="summary-sig-name">kernel_metadata</a>(<span class="summary-sig-arg">start_time</span>,
        <span class="summary-sig-arg">end_time</span>,
        <span class="summary-sig-arg">exec_time</span>,
        <span class="summary-sig-arg">event_count</span>,
        <span class="summary-sig-arg">event_rate</span>)</span><br />
      Result-producing replacement for the kernel metadata function</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#kernel_metadata">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="simvoc.core.results-module.html#JOB_STATUS_MAP" class="summary-name">JOB_STATUS_MAP</a> = <code title="{'finished': {'finished': 1},
 'started': {'started': 1},
 'submitted': {'submitted': 1}}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">finished</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">finished</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-group">}</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">started</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">st</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'simvoc.core'"><code class="variable-quote">'</code><code class="variable-string">simvoc.core</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<p class="indent-wrapped-lines"><b>Imports:</b>
  <a href="simvoc.core.units-module.html#fmt_size" title="simvoc.core.units.fmt_size">fmt_size</a>,
  <a href="simvoc.core.units-module.html#fmt_speed" title="simvoc.core.units.fmt_speed">fmt_speed</a>,
  <span title="simvoc.core.core_common.SM_WAITING">SM_WAITING</span>,
  <span title="simvoc.core.core_common.SM_RUNNING">SM_RUNNING</span>,
  <span title="simvoc.core.core_common.SM_COMPLETED">SM_COMPLETED</span>,
  <span title="simvoc.core.core_common.SM_ERRORS">SM_ERRORS</span>
</p><br />
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="kernel_trace"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">kernel_trace</span>(<span class="sig-arg">simtime</span>,
        <span class="sig-arg">realtime</span>,
        <span class="sig-arg">msg</span>,
        <span class="sig-arg">qsize</span>,
        <span class="sig-arg">events</span>,
        <span class="sig-arg">rate</span>,
        <span class="sig-arg">de</span>,
        <span class="sig-arg">dq</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#kernel_trace">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Result-producing replacement for the kernel trace function</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>simtime</code></strong> (number) - Current simulated time</li>
        <li><strong class="pname"><code>realtime</code></strong> (float) - Current wall clock time in UTC seconds since the epoch</li>
        <li><strong class="pname"><code>msg</code></strong> (str) - Current simulator message</li>
        <li><strong class="pname"><code>qsize</code></strong> (int) - Current event queue size</li>
        <li><strong class="pname"><code>events</code></strong> (int) - Total number of events processed</li>
        <li><strong class="pname"><code>rate</code></strong> (float) - Event processing rate (events/sec)</li>
        <li><strong class="pname"><code>de</code></strong> (int) - Number of events processed since last trace update</li>
        <li><strong class="pname"><code>dq</code></strong> (int) - Change in event queue size since last trace update</li>
    </ul></dd>
    <dt>Returns: <a href="simvoc.core.results.TraceResult-class.html" 
      class="link">results.TraceResult</a></dt>
  </dl>
</td></tr></table>
</div>
<a name="kernel_metadata"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">kernel_metadata</span>(<span class="sig-arg">start_time</span>,
        <span class="sig-arg">end_time</span>,
        <span class="sig-arg">exec_time</span>,
        <span class="sig-arg">event_count</span>,
        <span class="sig-arg">event_rate</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#kernel_metadata">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Result-producing replacement for the kernel metadata function</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>start_time</code></strong> (float) - Simulation start time in UTC seconds since epoch</li>
        <li><strong class="pname"><code>end_time</code></strong> (float) - Simulation end time in UTC seconds since epoch</li>
        <li><strong class="pname"><code>exec_time</code></strong> (float) - Execution time (seconds) for the simulation</li>
        <li><strong class="pname"><code>event_count</code></strong> (int) - Total number of events processed during the run</li>
        <li><strong class="pname"><code>event_rate</code></strong> (float) - Average event processing rate over the run</li>
    </ul></dd>
    <dt>Returns: <a href="simvoc.core.results.MetadataResult-class.html" 
      class="link">results.MetadataResult</a></dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="JOB_STATUS_MAP"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">JOB_STATUS_MAP</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">finished</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">finished</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-group">}</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">started</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">started</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-group">}</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">submitted</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">submitted</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-group">}</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:28 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
